Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.widget.custom/CustomListWidget

CustomListWidget

abstract class CustomListWidget<E : CustomListWidget.Entry<*>>(client: MinecraftClient, x: Int, y: Int, width: Int, height: Int) : ClickableWidget, ParentElement

A custom list widget implementation with improved scrolling, positioning, and interaction mechanics

Author

fzzyhmstrs

Since

0.6.0

Parameters

client

MinecraftClient the client instance

x

Widgets x screen position

y

Widgets y screen position

width

Widget width in pixels

height

Widget height in pixels

Inheritors

DynamicListWidget

Constructors

CustomListWidget

constructor(client: MinecraftClient, x: Int, y: Int, width: Int, height: Int)

Types

abstract class Entry<P : ParentElement>(val parentElement: P) : Element

A list entry. This is responsible for managing its own position, rendering of the list row, management of any children widgets, providing correct navigation, narration, and so on.

Properties

var active: Boolean

var message: Text

navigationOrder

var navigationOrder: Int

var visible: Boolean

var x: Int

var y: Int

Functions

appendNarrations

override fun appendNarrations(builder: NarrationMessageBuilder)

abstract fun bottomDelta(): Int

The length in pixels that the bottom of the list is out of frame below the bottom of the widget.

open fun charTyped(chr: Char, modifiers: Int): Boolean

abstract fun contentHeight(): Int

The height of the entries in the list. If the list contains twenty 20px entries, content height is 400

abstract fun ensureVisible(entry: E)

Ensures that the provided entry is in frame. Implementations should scroll as needed to fully incorporate the entry into the widget frame.

abstract fun entryAtY(mouseY: Int): E?

The entry underneath the mouse, if any.

open override fun forEachChild(consumer: Consumer<ClickableWidget>)

open fun getBottom(): Int

open override fun getFocused(): Element?

@Nullable

open fun getFocusedPath(): GuiNavigationPath?

open override fun getHeight(): Int

getNavigationFocus

open override fun getNavigationFocus(): ScreenRect

getNavigationPath

open override fun getNavigationPath(navigation: GuiNavigation?): GuiNavigationPath?

Return a navigation path leading through this list and to an entry, as applicable. The default implementation will likely not function properly; see DynamicListWidget for an example implementation

open fun getRight(): Int

@Nullable

open fun getTooltip(): Tooltip?

open override fun getType(): Selectable.SelectionType

open override fun getWidth(): Int

abstract fun handleScroll(verticalAmount: Double): Boolean

Handles a scroll input. This is scroll from a mouse, so the input should be multiplied by a factor to make scroll distance reasonable.

handleScrollByBar

abstract fun handleScrollByBar(scrollAmount: Int): Boolean

Handles "direct" scroll input. This amount is not scaled, so the amount input should be the amount scrolled.

hideScrollWhileNotHovered

open fun hideScrollWhileNotHovered(): Boolean

Whether the scroll bar should not render if the widget isn't hovered. Default false.

open fun hoveredElement(mouseX: Double, mouseY: Double): Optional<Element>

abstract fun inFrameEntries(): List<E>

Entries that are currently visible in the list frame. These entries will be rendered as applicable. Entries partially in frame should be included.

open override fun isFocused(): Boolean

open fun isHovered(): Boolean

open override fun isMouseOver(mouseX: Double, mouseY: Double): Boolean

open override fun isNarratable(): Boolean

open fun isSelected(): Boolean

open fun keyPressed(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

open fun keyReleased(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

listNarrationKey

open fun listNarrationKey(): String

open override fun mouseClicked(mouseX: Double, mouseY: Double, button: Int): Boolean

open override fun mouseDragged(mouseX: Double, mouseY: Double, button: Int, deltaX: Double, deltaY: Double): Boolean

open fun mouseMoved(mouseX: Double, mouseY: Double)

open override fun mouseReleased(mouseX: Double, mouseY: Double, button: Int): Boolean

open override fun mouseScrolled(mouseX: Double, mouseY: Double, horizontalAmount: Double, verticalAmount: Double): Boolean

open fun onClick(mouseX: Double, mouseY: Double)

open fun onRelease(mouseX: Double, mouseY: Double)

open fun onReposition()

This is run when the widget is moved or resized. List elements should be repositioned when this is called.

fun page(up: Boolean)

"Pages" the list up or down as if Page Up/Down has been pressed.

open fun playDownSound(soundManager: SoundManager)

override fun render(context: DrawContext, mouseX: Int, mouseY: Int, delta: Float)

fun rowWidth(): Int

The content width of the row, excluding padding and space for the scroll bar

fun rowX(): Int

The X position of the row content, after padding

abstract fun scrollToBottom(): Boolean

Scroll to the bottom of the list content. bottomDelta should be 0 or negative after this scroll

abstract fun scrollToTop(): Boolean

Scroll to the top of the list content. topDelta should be 0 after this scroll.

selectableEntries

abstract fun selectableEntries(): List<E>

List entries tht are currently selectable. Hidden or otherwise disabled entries should not be counted in this list.

open fun setAlpha(alpha: Float)

open override fun setFocused(focused: Boolean)

open override fun setFocused(focused: Element?)

open fun setHeight(height: Int)

open fun setTooltip(@Nullable tooltip: Tooltip?)

setTooltipDelay

open fun setTooltipDelay(tooltipDelay: Duration)

open fun setWidth(width: Int)

abstract fun topDelta(): Int

The length in pixels that the top of the list is out of frame above the top of the widget.